<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="../css/docs.css" type="text/css" rel="stylesheet" />
<link href="../css/prettify.css" type="text/css" rel="stylesheet" />
<script src="../js/prettify.js" type="text/javascript"></script>
</head>
<body onLoad="prettyPrint()">
<div class="g-unit" id="doc-content">
<div id="api-info-block">
<div class="api-level">H3C CAS云管理平台</div>
</div>
<div id="jd-header">
<h1>查询集群下空vGPU资源列表</h1>
</div>
<div id="jd-content">
<div class="jd-descr">
<p>查询集群下空闲vGPU资源列表。</p>
<h2><a name="uri"></a>接口 URI</h2>
<p>/cas/casrs/resPool/queryVgpuList?clusterId={clusterId}&amp;id={id}</p>
<h2><a name="access"></a>访问方法</h2>
<dl>
  <dt><b>HTTP 方法</b></dt>
  <dd>GET</dd>
  <dt><b>参数</b></dt><br>
  <table id="pubmethods" class="jd-sumtable"><tbody><tr>
          <th colspan="2">查询参数（Query Parameter）</th>
        </tr>
	        <tr >
	          <td class="jd-typecol">clusterId</td>
	          <td class="jd-linkcol" width="100%">
	            <span class="sympad">集群id 。</span>
                <div class="jd-descrdiv">长整数（long）类型。必须。</div>	          </td>
	        </tr>
			<tr class="alt-color">
	          <td class="jd-typecol">id</td>
	          <td class="jd-linkcol" width="100%">
	            <span class="sympad">资源池id 。当修改资源池时查询集群下空闲vGPU需要此项。</span>
                <div class="jd-descrdiv">长整数（long）类型。可选。</div>	          </td>
	        </tr>
        </table>
		
  </dl>
<h2><a name="result"></a>返回结果</h2>
<dl>
  <dt><b>状态码</b></dt>
  <dd>
  <ul>
    <li>200(OK)：成功。</li>
  </ul>
  </dd>
  <dt><b>消息头</b></dt>
  <div class="source"><pre class="prettyprint lang-xml">HTTP/1.1 200 OK<br>Cache-Control: no-cache, no-store, max-age=0, must-revalidate<br>Pragma: no-cache<br>Expires: 0<br>X-XSS-Protection: 1; mode=block<br>X-Frame-Options: DENY<br>X-Content-Type-Options: nosniff<br>Content-Type: application/xml<br>Content-Length: 644<br>Date: Sat, 03 Feb 2018 09:00:20 GMT<br>Server: CVM</pre>
  </div>
  <dt><b>消息体</b></dt>
  <div class="source"><pre class="prettyprint lang-xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>&lt;list&gt;<br>  &lt;vgpu&gt;<br>    &lt;bus&gt;0000:05:00.0&lt;/bus&gt;
    &lt;name&gt;GRID M60-0Q&lt;/name&gt;
    &lt;type&gt;nvidia-12&lt;/type&gt;
    &lt;heads&gt;2&lt;/heads&gt;
    &lt;framebuffer&gt;512M&lt;/framebuffer&gt;
    &lt;maxResolution&gt;2560x1600&lt;/maxResolution&gt;
    &lt;maxInstance&gt;16&lt;/maxInstance&gt;
    &lt;uuid&gt;c2177883-f1bb-47f0-914d-32a22e3a8804&lt;uuid&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostId&gt;13&lt;/hostId&gt;<br>    &lt;hostName&gt;cvk2059&lt;/hostName&gt;<br>  &lt;/vgpu&gt;<br>&lt;/list&gt;</pre>
  </div>
</dl>
<dt><a name="detail"></a><b>元素含义</b></dt>
<table class="jd-sumtable" id="pubmethods">
  <tbody>
    <tr>
      <th colspan="2"><span class="prettyprint lang-xml">vgpu</span>各子元素</th>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">bus</span></td>
      <td class="jd-linkcol"><span class="sympad">GPU槽号。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">clusterId</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">资源所在的集群ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
	<tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">hostId</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">资源所在的主机ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
	<tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">hostName</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">资源所在的主机名称。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
	<tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">type</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">vGPU的类型。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
	<tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">name</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">vGPU的名称。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
	<tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">maxInstance</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">vGPU的最大虚拟个数。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
	<tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">framebuffer</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">vGPU的帧缓存。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
	<tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">maxResolution</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">vGPU的最大分辨率。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
	<tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">heads</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">vGPU的显示器接口数。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
	<tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">uuid</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">vGPU的UUID唯一标识符。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
</table>
<h2><a name="example"></a>应用举例</h2>
    <p>1.查询集群下空闲vGPU资源列表。</p>
    <dl>
      <dt><b>请求</b></dt>
      <div class="source">
        <pre class="prettyprint lang-xml">GET http://localhost:8080/cas/casrs/resPool/queryVgpuList?clusterId=1&amp;id=1
accept: application/xml
...
        </pre>
      </div>
      <dt><b>回应</b></dt>
      <div class="source">
        <pre class="prettyprint lang-xml">HTTP/1.1 200 OK<br>Cache-Control: no-cache, no-store, max-age=0, must-revalidate<br>Pragma: no-cache<br>Expires: 0<br>X-XSS-Protection: 1; mode=block<br>X-Frame-Options: DENY<br>X-Content-Type-Options: nosniff<br>Content-Type: application/xml<br>Content-Length: 644<br>Date: Sat, 03 Feb 2018 09:00:20 GMT<br>Server: CVM
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>&lt;list&gt;<br>  &lt;vgpu&gt;<br>    &lt;bus&gt;0000:05:00.0&lt;/bus&gt;
    &lt;name&gt;GRID M60-0Q&lt;/name&gt;
    &lt;type&gt;nvidia-12&lt;/type&gt;
    &lt;heads&gt;2&lt;/heads&gt;
    &lt;framebuffer&gt;512M&lt;/framebuffer&gt;
    &lt;maxResolution&gt;2560x1600&lt;/maxResolution&gt;
    &lt;maxInstance&gt;16&lt;/maxInstance&gt;
    &lt;uuid&gt;c2177883-f1bb-47f0-914d-32a22e3a8804&lt;uuid&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostId&gt;13&lt;/hostId&gt;<br>    &lt;hostName&gt;cvk2059&lt;/hostName&gt;<br>  &lt;/vgpu&gt;<br>&lt;/list&gt;</pre>
      </div>
    </dl>
    </div>
</div>
</div>
</body>
</html>